Plotly for Matlab is now entirely open source, free, and self-hosted
Learn more about why we've open sourced

matlab figure reference

fig2plotly converts MATLAB figures to online Plotly graphs. MATLAB describes figures differently than Plotly. Plotly's MATLAB library crawls the MATLAB figure objects and translates the MATLAB attributes into the structure that Plotly uses to describe and draw data visualizations.

You may wish to customize the figure after you have translated it but before you have sent it to Plotly. You can customize every attribute of a plotly graph: the hover text, the colorscales, the gridlines, the histogram binning, etc.

plotly charts are described declaratively with struct and cell array objects. This page contains an extensive list of the keys used to describe plotly graphs inside these struct objects. Here is a simple example of how to translate a MATLAB figure, modify some attributes, and then send it to Plotly.

>> x = linspace(-2*pi, 2*pi);
>> y1 = sin(x);
>> y2 = cos(x);
>> plot(x, y1, x, y2);

%% Translate the figure from MATLAB to Plotly
>> fig = plotlyfig(gcf);

>> fig.PlotOptions.Strip = 0; % If 0, don't strip MATLAB's styling in translation. If 1, strip MATLAB's styling.

>> fig.data
ans =

   [1x1 struct]    [1x1 struct]

>> fig.data{1}    % The 'type' of this trace is 'scatter'. scatter's reference: #scatter
ans =

        xaxis: 'x1'             % more about scatter's 'xaxis': #scatter-xaxis
        yaxis: 'y1'             % scatter's 'yaxis' property:   #scatter-yaxis
         type: 'scatter'
      visible: 1                % scatter's 'visible' property: #scatter-visible
            x: [1x100 double]   % scatter's 'x' property:       #scatter-x
            y: [1x100 double]   % scatter's 'y' property:       #scatter-y
         name: ''               % scatter's 'name' property:    #scatter-name
         mode: 'lines'          % scatter's 'mode' property:    #scatter-mode
         line: [1x1 struct]     % scatter's 'line' property:    #scatter-line
       marker: [1x1 struct]     % scatter's 'marker' property:  #scatter-marker
   showlegend: 1                % scatter's 'showlegend':       #scatter-marker

%% Modify or add new properties to this trace
>> fig.data{1}.name = 'Current'; % Update the legend name to 'Current'

>> fig.layout     % layout reference: #layout
ans =

        autosize: 0                     % layout's 'autosize':      #layout-autosize
          margin: [1x1 struct]          % layout's 'margin':        #layout-margin
      showlegend: 0                     % layout's 'showlegend':    #layout-showlegend
           width: 840                   % layout's 'width':         #layout-width
          height: 630                   % layout's 'height':        #layout-height
   paper_bgcolor: 'rgb(255,255,255)'    % layout's 'paper_bgcolor': #layout-paper_bgcolor
       hovermode: 'closest'             % layout's 'hovermode':     #layout-hovermode
    plot_bgcolor: 'rgba(0,0,0,0)'       % layout's 'plot_bgcolor':  #layout-plot_bgcolor
          xaxis1: [1x1 struct]          % layout's 'xaxis':         #layout-xaxis
          yaxis1: [1x1 struct]          % layout's 'yaxis':         #layout-yaxis
     annotations: {[1x1 struct]}        % layout's 'annotations':   #layout-annotations

>> fig.layout.showlegend = true;  % layout's 'showlegend':    #layout-showlegend
>> fig.layout.legend = struct('x', 1, 'y', 1); % Update the legend: #layout-legend
>> fig.layout.title = 'Modified plot';

%% Set the filename, and overwrite the plot if it already exists
>> fig.PlotOptions.FileName = 'Customized plot';
>> fig.PlotOptions.FileOpt = 'overwrite';
>> % using offline? Then set fig.PlotOptions.Offline = true;

%% Send to plotly
>> fig.plotly


scatter

A scatter trace is a struct inside fig.data which has type equal to 'scatter'. This section lists all of the valid keys that a scatter struct can contain.

The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in `x` and `y`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.

  • type ('scatter')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • x (array)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • mode (flaglist string)
    Any combination of 'lines', 'markers', 'text' joined with a '+' OR 'none'.
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points, then the default is 'lines+markers'. Otherwise, 'lines'.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • shape (enumerated: 'linear' | 'spline' | 'hv' | 'vh' | 'hvh' | 'vhv' )
      default: 'linear'
      Determines the line shape. With 'spline' the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Has only an effect if `shape` is set to 'spline' Sets the amount of smoothing. '0' corresponds to no smoothing (equivalent to a 'linear' shape).
    • dash (string)
      default: 'solid'
      Sets the style of the lines. Set to a dash string type or a dash length in px.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  • fill (enumerated: 'none' | 'tozeroy' | 'tozerox' | 'tonexty' | 'tonextx' )
    default: 'none'
    Sets the area to fill with a solid color. Use with `fillcolor`.
  • fillcolor (color)
    Sets the fill color.
  • marker
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets the marker color.
    • maxdisplayed (number greater than or equal to 0)
      default: 0
      Sets a maximum number of points to be drawn on the graph. '0' corresponds to no limit.
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.line.color` is set to a numerical array. Reverses the colorscale.
      • colorsrc
      • widthsrc
    • colorbar
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
      • dtick (number or categorical coordinate string)
        default: 1
        Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont
        Sets this color bar's title font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
        Determines the location of the colorbar title with respect to the color bar.
      • tickvalssrc
      • ticktextsrc
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'middle center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    Sets the text font.
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • xsrc
  • ysrc
  • textsrc
  • textpositionsrc
  • rsrc
  • tsrc

bar

A bar trace is a struct inside fig.data which has type equal to 'bar'. This section lists all of the valid keys that a bar struct can contain.

The data visualized by the span of the bars is set in `y` if `orientation` is set th 'v' (the default) and the labels are set in `x`. By setting `orientation` to 'h', the roles are interchanged.

  • type ('bar')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • x (array)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • marker
    • color (color)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.line.color` is set to a numerical array. Reverses the colorscale.
      • colorsrc
      • widthsrc
    • colorbar
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
      • dtick (number or categorical coordinate string)
        default: 1
        Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont
        Sets this color bar's title font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
        Determines the location of the colorbar title with respect to the color bar.
      • tickvalssrc
      • ticktextsrc
    • colorsrc
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • xsrc
  • ysrc
  • textsrc
  • rsrc
  • tsrc

box

A box trace is a struct inside fig.data which has type equal to 'box'. This section lists all of the valid keys that a box struct can contain.

In vertical (horizontal) box plots, statistics are computed using `y` (`x`) values. By supplying an `x` (`y`) array, one box per distinct x (y) value is drawn If no `x` (`y`) cell array is provided, a single box is drawn. That box position is then positioned with with `name` or with `x0` (`y0`) if provided. Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The second quartile (Q2) is marked by a line inside the box. By default, the whiskers correspond to the box' edges +/- 1.5 times the interquartile range (IQR = Q3-Q1), see 'boxpoints' for other options.

  • type ('box')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • y (array)
    Sets the y sample data or coordinates. See overview for more info.
  • x (array)
    Sets the x sample data or coordinates. See overview for more info.
  • x0 (number or categorical coordinate string)
    Sets the x coordinate of the box. See overview for more info.
  • y0 (number or categorical coordinate string)
    Sets the y coordinate of the box. See overview for more info.
  • whiskerwidth (number between or equal to 0 and 1)
    default: 0.5
    Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).
  • boxpoints (enumerated: 'all' | 'outliers' | 'suspectedoutliers' | false )
    default: 'outliers'
    If 'outliers', only the sample points lying outside the whiskers are shown If 'suspectedoutliers', the outlier points are shown and points either less than 4'Q1-3'Q3 or greater than 4'Q3-3'Q1 are highlighted (see `outliercolor`) If 'all', all sample points are shown If 'false', only the box(es) are shown with no sample points
  • boxmean (enumerated: true | 'sd' | false )
    If 'true', the mean of the box(es)' underlying distribution is drawn as a dashed line inside the box(es). If 'sd' the standard deviation is also drawn.
  • jitter (number between or equal to 0 and 1)
    Sets the amount of jitter in the sample points drawn. If '0', the sample points align along the distribution axis. If '1', the sample points are drawn in a random jitter of width equal to the width of the box(es).
  • pointpos (number between or equal to -2 and 2)
    Sets the position of the sample points in relation to the box(es). If '0', the sample points are places over the center of the box(es). Positive (negative) values correspond to positions to the right (left) for vertical boxes and above (below) for horizontal boxes
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the box(es). If 'v' ('h'), the distribution is visualized along the vertical (horizontal).
  • marker
    • outliercolor (color)
      default: 'rgba(0, 0, 0, 0)'
      Sets the color of the outlier sample points.
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      default: 1
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • color (color)
      Sets the marker color.
    • line
      • color (color)
        default: '#444'
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the lines bounding the marker points.
      • outliercolor (color)
        Sets the border line color of the outlier sample points. Defaults to marker.color
      • outlierwidth (number greater than or equal to 0)
        default: 1
        Sets the border line width (in px) of the outlier sample points.
  • line
    • color (color)
      Sets the color of line bounding the box(es).
    • width (number greater than or equal to 0)
      default: 2
      Sets the width (in px) of line bounding the box(es).
  • fillcolor (color)
    Sets the fill color.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • ysrc
  • xsrc

heatmap

A heatmap trace is a struct inside fig.data which has type equal to 'heatmap'. This section lists all of the valid keys that a heatmap struct can contain.

The data that describes the heatmap value-to-color mapping is set in `z`. Data in `z` can either be a matrix of values (ragged or not) or a 1D array of values. In the case where `z` is a matrix, say that `z` has N rows and M columns. Then, by default, the resulting heatmap will have N partitions along the y axis and M partitions along the x axis. In other words, the i-th row/ j-th column cell in `z` is mapped to the i-th partition of the y axis (starting from the bottom of the plot) and the j-th partition of the x-axis (starting from the left of the plot). This behavior can be flipped by using `transpose`. Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) elements If M (N), then the coordinates correspond to the center of the heatmap cells and the cells have equal width. If M+1 (N+1), then the coordinates correspond to the edges of the heatmap cells. In the case where `z` is a 1D cell array, the x and y coordinates must be provided in `x` and `y` respectively to form data triplets.

  • type ('heatmap')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • z (array)
    Sets the z data.
  • x (array)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • zsrc
  • xsrc
  • ysrc
  • textsrc

histogram

A histogram trace is a struct inside fig.data which has type equal to 'histogram'. This section lists all of the valid keys that a histogram struct can contain.

The sample data from which statistics are computed is set in `x` for vertically spanning histograms and in `y` for horizontally spanning histograms. Binning options are set `xbins` and `ybins` respectively if no aggregation data is provided.

  • type ('histogram')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • marker
    • color (array)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.line.color` is set to a numerical array. Reverses the colorscale.
      • colorsrc
      • widthsrc
    • colorbar
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
      • dtick (number or categorical coordinate string)
        default: 1
        Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont
        Sets this color bar's title font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
        Determines the location of the colorbar title with respect to the color bar.
      • tickvalssrc
      • ticktextsrc
    • colorsrc
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • z (array)
    Sets the aggregation data.
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (number or categorical coordinate string)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (number or categorical coordinate string)
      default: 1
      Sets the step in-between value each y axis bin.
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • xsrc
  • ysrc
  • textsrc
  • rsrc
  • tsrc
  • zsrc

histogram2d

A histogram2d trace is a struct inside fig.data which has type equal to 'histogram2d'. This section lists all of the valid keys that a histogram2d struct can contain.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a heatmap.

  • type ('histogram2d')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • z (array)
    Sets the aggregation data.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • marker
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (number or categorical coordinate string)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (number or categorical coordinate string)
      default: 1
      Sets the step in-between value each y axis bin.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • zsrc
  • xsrc
  • ysrc
  • textsrc

pie

A pie trace is a struct inside fig.data which has type equal to 'pie'. This section lists all of the valid keys that a pie struct can contain.

A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`

  • type ('pie')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'label', 'text', 'value', 'percent', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'label', 'text', 'label+text', 'label+text+value', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • labels (array)
    Sets the sector labels.
  • label0 (number)
    default: 0
    Alternate to `labels`. Builds a numeric set of labels. Use with `dlabel` where `label0` is the starting label and `dlabel` the step.
  • dlabel (number)
    default: 1
    Sets the label step. See `label0` for more info.
  • marker
    • colors (array)
      Sets the color of each sector of this pie chart. If not specified, the default trace color set is used to pick the sector colors.
    • line
      • color (color)
        default: '#444'
        Sets the color of the line enclosing each sector.
      • width (number greater than or equal to 0)
        default: 0
        Sets the width (in px) of the line enclosing each sector.
      • colorsrc
      • widthsrc
    • colorssrc
  • text (array)
    Sets text elements associated with each sector.
  • scalegroup (string)
    default: ''
    If there are multiple pies that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
  • textinfo (flaglist string)
    Any combination of 'label', 'text', 'value', 'percent' joined with a '+' OR 'none'.
    examples: 'label', 'text', 'label+text', 'label+text+value', 'none'
    Determines which trace information appear on the graph.
  • textposition (enumerated: 'inside' | 'outside' | 'auto' | 'none' )
    default: 'auto'
    Specifies the location of the `textinfo`.
  • textfont
    Sets the font used for `textinfo`.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
    • size (number greater than or equal to 1)
    • color (color)
  • insidetextfont
    Sets the font used for `textinfo` lying inside the pie.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
    • size (number greater than or equal to 1)
    • color (color)
  • outsidetextfont
    Sets the font used for `textinfo` lying outside the pie.
    • family (string)
      HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
    • size (number greater than or equal to 1)
    • color (color)
  • domain
    • x (cell array)
      default: [0, 1]
      Sets the horizontal domain of this pie trace (in plot fraction).
      Each struct has one or more of the keys listed below.
    • y (cell array)
      default: [0, 1]
      Sets the vertical domain of this pie trace (in plot fraction).
      Each struct has one or more of the keys listed below.
  • hole (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.
  • sort (boolean)
    default: true
    Determines whether or not the sectors of reordered from largest to smallest.
  • direction (enumerated: 'clockwise' | 'counterclockwise' )
    default: 'counterclockwise'
    Specifies the direction at which succeeding sectors follow one another.
  • rotation (number between or equal to -360 and 360)
    default: 0
    Instead of the first slice starting at 12 o'clock, rotate to some other angle.
  • pull (number between or equal to 0 and 1)
    default: 0
    Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.
  • labelssrc
  • valuessrc
  • textsrc
  • textpositionsrc
  • pullsrc

contour

A contour trace is a struct inside fig.data which has type equal to 'contour'. This section lists all of the valid keys that a contour struct can contain.

The data from which contour lines are computed is set in `z`. Data in `z` must be a matrix of numbers. Say that `z` has N rows and M columns, then by default, these N rows correspond to N y coordinates (set in `y` or auto-generated) and the M columns correspond to M x coordinates (set in `x` or auto-generated). By setting `transpose` to 'true', the above behavior is flipped.

  • type ('contour')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • z (array)
    Sets the z data.
  • x (array)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • autocontour (boolean)
    default: true
    Determines whether of not the contour level attributes at picked by an algorithm. If 'true', the number of contour levels can be set in `ncontours`. If 'false', set the contour level attributes in `contours`.
  • ncontours (integer)
    default: 0
    Sets the number of contour levels.
  • contours
    • start (number)
      Sets the starting contour level value.
    • end (number)
      Sets the end contour level value.
    • size (number)
      Sets the step between each contour level.
    • coloring (enumerated: 'fill' | 'heatmap' | 'lines' | 'none' )
      default: 'fill'
      Determines the coloring method showing the contour values. If 'fill', coloring is done evenly between each contour level If 'heatmap', a heatmap gradient is coloring is applied between each contour level. If 'lines', coloring is done on the contour lines. If 'none', no coloring is applied on this trace.
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to 'fill'.
  • line
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to 'lines'.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines. Set to a dash string type or a dash length in px.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where '0' corresponds to no smoothing.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • zsrc
  • xsrc
  • ysrc
  • textsrc

histogram2dcontour

A histogram2dcontour trace is a struct inside fig.data which has type equal to 'histogram2dcontour'. This section lists all of the valid keys that a histogram2dcontour struct can contain.

The sample data from which statistics are computed is set in `x` and `y` (where `x` and `y` represent marginal distributions, binning is set in `xbins` and `ybins` in this case) or `z` (where `z` represent the 2D distribution and binning set, binning is set by `x` and `y` in this case). The resulting distribution is visualized as a contour plot.

  • type ('histogram2dcontour')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • z (array)
    Sets the aggregation data.
  • x (array)
    Sets the sample data to be binned on the x axis.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the sample data to be binned on the y axis.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (array)
    Sets the text elements associated with each z value.
  • transpose (boolean)
    Transposes the z data.
  • xtype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's x coordinates are given by 'x' (the default behavior when `x` is provided). If 'scaled', the heatmap's x coordinates are given by 'x0' and 'dx' (the default behavior when `x` is not provided).
  • ytype (enumerated: 'array' | 'scaled' )
    If 'array', the heatmap's y coordinates are given by 'y' (the default behavior when `y` is provided) If 'scaled', the heatmap's y coordinates are given by 'y0' and 'dy' (the default behavior when `y` is not provided)
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • zsmooth (enumerated: 'fast' | 'best' | false )
    Picks a smoothing algorithm use to smooth `z` data.
  • connectgaps (boolean)
    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • marker
  • orientation (enumerated: 'v' | 'h' )
    Sets the orientation of the bars. With 'v' ('h'), the value of the each bar spans along the vertical (horizontal).
  • histfunc (enumerated: 'count' | 'sum' | 'avg' | 'min' | 'max' )
    default: 'count'
    Specifies the binning function used for this histogram trace. If 'count', the histogram values are computed by counting the number of values lying inside each bin. If 'sum', 'avg', 'min', 'max', the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.
  • histnorm (enumerated: '' | 'percent' | 'probability' | 'density' | 'probability density' )
    default: ''
    Specifies the type of normalization used for this histogram trace. If '', the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If 'percent', the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If 'density', the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If 'probability density', the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).
  • autobinx (boolean)
    default: true
    Determines whether or not the x axis bin attributes are picked by an algorithm.
  • nbinsx (integer greater than or equal to 0)
    default: 0
    Sets the number of x axis bins.
  • xbins
    • start (number)
      Sets the starting value for the x axis bins.
    • end (number)
      Sets the end value for the x axis bins.
    • size (number or categorical coordinate string)
      default: 1
      Sets the step in-between value each x axis bin.
  • autobiny (boolean)
    default: true
    Determines whether or not the y axis bin attributes are picked by an algorithm.
  • nbinsy (integer greater than or equal to 0)
    default: 0
    Sets the number of y axis bins.
  • ybins
    • start (number)
      Sets the starting value for the y axis bins.
    • end (number)
      Sets the end value for the y axis bins.
    • size (number or categorical coordinate string)
      default: 1
      Sets the step in-between value each y axis bin.
  • autocontour (boolean)
    default: true
    Determines whether of not the contour level attributes at picked by an algorithm. If 'true', the number of contour levels can be set in `ncontours`. If 'false', set the contour level attributes in `contours`.
  • ncontours (integer)
    default: 0
    Sets the number of contour levels.
  • contours
    • start (number)
      Sets the starting contour level value.
    • end (number)
      Sets the end contour level value.
    • size (number)
      Sets the step between each contour level.
    • coloring (enumerated: 'fill' | 'heatmap' | 'lines' | 'none' )
      default: 'fill'
      Determines the coloring method showing the contour values. If 'fill', coloring is done evenly between each contour level If 'heatmap', a heatmap gradient is coloring is applied between each contour level. If 'lines', coloring is done on the contour lines. If 'none', no coloring is applied on this trace.
    • showlines (boolean)
      default: true
      Determines whether or not the contour lines are drawn. Has only an effect if `contours.coloring` is set to 'fill'.
  • line
    • color (color)
      Sets the color of the contour level. Has no if `contours.coloring` is set to 'lines'.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines. Set to a dash string type or a dash length in px.
    • smoothing (number between or equal to 0 and 1.3)
      default: 1
      Sets the amount of smoothing for the contour lines, where '0' corresponds to no smoothing.
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • zsrc
  • xsrc
  • ysrc
  • textsrc

scatter3d

A scatter3d trace is a struct inside fig.data which has type equal to 'scatter3d'. This section lists all of the valid keys that a scatter3d struct can contain.

The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.

  • type ('scatter3d')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • x (array)
    Sets the x coordinates.
  • y (array)
    Sets the y coordinates.
  • z (array)
    Sets the z coordinates.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates.
  • mode (flaglist string)
    Any combination of 'lines', 'markers', 'text' joined with a '+' OR 'none'.
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    default: 'lines+markers'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points, then the default is 'lines+markers'. Otherwise, 'lines'.
  • surfaceaxis (enumerated: '-1' | '0' | '1' | '2' )
    default: '-1'
    If '-1', the scatter points are not fill with a surface If '0', '1', '2', the scatter points are filled with a Delaunay surface about the x, y, z respectively.
  • surfacecolor (color)
    Sets the surface fill color.
  • projection
    • x
      • show (boolean)
        Sets whether or not projections are shown along the x axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • y
      • show (boolean)
        Sets whether or not projections are shown along the y axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
    • z
      • show (boolean)
        Sets whether or not projections are shown along the z axis.
      • opacity (number between or equal to 0 and 1)
        default: 1
        Sets the projection color.
      • scale (number between or equal to 0 and 10)
        default: 0.6666666666666666
        Sets the scale factor determining the size of the projection marker points.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines. Set to a dash string type or a dash length in px.
  • marker
    • color (color)
      Sets the marker color.
    • symbol (enumerated: 'circle' | 'circle-open' | 'square' | 'square-open' | 'diamond' | 'diamond-open' | 'cross' | 'x' )
      default: 'circle'
      Sets the marker symbol type.
    • size (number greater than or equal to 0)
      default: 8
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.line.color` is set to a numerical array. Reverses the colorscale.
      • colorsrc
    • colorbar
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
      • dtick (number or categorical coordinate string)
        default: 1
        Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont
        Sets this color bar's title font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
        Determines the location of the colorbar title with respect to the color bar.
      • tickvalssrc
      • ticktextsrc
    • colorsrc
    • symbolsrc
    • sizesrc
    • opacitysrc
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'top center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • textfont
    Sets the text font.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_z
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • xsrc
  • ysrc
  • zsrc
  • textsrc
  • textpositionsrc

surface

A surface trace is a struct inside fig.data which has type equal to 'surface'. This section lists all of the valid keys that a surface struct can contain.

The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a matrix. Coordinates in `x` and `y` can either be 1D cell arrays or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step.

  • type ('surface')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • z (array)
    Sets the z coordinates.
  • x (array)
    Sets the x coordinates.
  • y (array)
    Sets the y coordinates.
  • text (array)
    Sets the text elements associated with each z value.
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • contours
    • x
      • show (boolean)
        Sets whether or not dynamic contours are shown along the x axis
      • project
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
    • y
      • show (boolean)
        Sets whether or not dynamic contours are shown along the y axis
      • project
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
    • z
      • show (boolean)
        Sets whether or not dynamic contours are shown along the z axis
      • project
        • x (boolean)
          Sets whether or not the dynamic contours are projected along the x axis.
        • y (boolean)
          Sets whether or not the dynamic contours are projected along the y axis.
        • z (boolean)
          Sets whether or not the dynamic contours are projected along the z axis.
      • color (color)
        default: '#000'
      • usecolormap (boolean)
      • width (number between or equal to 1 and 16)
        default: 2
      • highlight (boolean)
      • highlightColor (color)
        default: '#000'
      • highlightWidth (number between or equal to 1 and 16)
        default: 2
  • hidesurface (boolean)
  • lighting
    • ambient (number between or equal to 0 and 1)
      default: 0.8
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
    • specular (number between or equal to 0 and 2)
      default: 0.05
    • roughness (number between or equal to 0 and 1)
      default: 0.5
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • zsrc
  • xsrc
  • ysrc
  • textsrc

mesh3d

A mesh3d trace is a struct inside fig.data which has type equal to 'mesh3d'. This section lists all of the valid keys that a mesh3d struct can contain.



  • type ('mesh3d')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • x (array)
  • y (array)
  • z (array)
  • i (array)
  • j (array)
  • k (array)
  • delaunayaxis (enumerated: 'x' | 'y' | 'z' )
    default: 'z'
  • alphahull (number)
    default: -1
  • intensity (array)
  • color (color)
  • vertexcolor (array)
  • facecolor (array)
  • flatshading (boolean)
  • contour
    • show (boolean)
    • color (color)
      default: '#000'
    • width (number between or equal to 1 and 16)
      default: 2
  • colorscale (colorscale)
    Sets the colorscale.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • lighting
    • ambient (number between or equal to 0 and 1)
      default: 0.8
    • diffuse (number between or equal to 0 and 1)
      default: 0.8
    • specular (number between or equal to 0 and 2)
      default: 0.05
    • roughness (number between or equal to 0 and 1)
      default: 0.5
    • fresnel (number between or equal to 0 and 5)
      default: 0.2
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • scene (sceneid)
    default: scene
    Sets a reference between this trace's 3D coordinate system and a 3D scene. If 'scene' (the default value), the (x,y,z) coordinates refer to `layout.scene`. If 'scene2', the (x,y,z) coordinates refer to `layout.scene2`, and so on.
  • xsrc
  • ysrc
  • zsrc
  • isrc
  • jsrc
  • ksrc
  • intensitysrc
  • vertexcolorsrc
  • facecolorsrc

scattergeo

A scattergeo trace is a struct inside fig.data which has type equal to 'scattergeo'. This section lists all of the valid keys that a scattergeo struct can contain.

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in `lon` and `lat` respectively or by geographic location IDs or names in `locations`.

  • type ('scattergeo')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'lon', 'lat', 'location', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'lon', 'lat', 'lon+lat', 'lon+lat+location', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • lon (array)
    Sets the longitude coordinates (in degrees East).
  • lat (array)
    Sets the latitude coordinates (in degrees North).
  • locations (array)
    Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See `locationmode` for more info.
  • locationmode (enumerated: 'ISO-3' | 'USA-states' | 'country names' )
    default: 'ISO-3'
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • mode (flaglist string)
    Any combination of 'lines', 'markers', 'text' joined with a '+' OR 'none'.
    examples: 'lines', 'markers', 'lines+markers', 'lines+markers+text', 'none'
    default: 'markers'
    Determines the drawing mode for this scatter trace. If the provided `mode` includes 'text' then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points, then the default is 'lines+markers'. Otherwise, 'lines'.
  • text (string)
    default: ''
    Sets text elements associated with each (lon,lat) pair. or item in `locations`. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (lon,lat) or `locations` coordinates.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (string)
      default: 'solid'
      Sets the style of the lines. Set to a dash string type or a dash length in px.
  • marker
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • color (color)
      Sets the marker color.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.line.color` is set to a numerical array. Reverses the colorscale.
      • colorsrc
      • widthsrc
    • colorbar
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
      • dtick (number or categorical coordinate string)
        default: 1
        Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont
        Sets this color bar's title font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
        Determines the location of the colorbar title with respect to the color bar.
      • tickvalssrc
      • ticktextsrc
    • symbolsrc
    • opacitysrc
    • sizesrc
    • colorsrc
  • textfont
    Sets the text font.
  • textposition (enumerated: 'top left' | 'top center' | 'top right' | 'middle left' | 'middle center' | 'middle right' | 'bottom left' | 'bottom center' | 'bottom right' )
    default: 'middle center'
    Sets the positions of the `text` elements with respects to the (x,y) coordinates.
  • geo (geoid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If 'geo' (the default value), the geospatial coordinates refer to `layout.geo`. If 'geo2', the geospatial coordinates refer to `layout.geo2`, and so on.
  • lonsrc
  • latsrc
  • locationssrc
  • textsrc
  • textpositionsrc

choropleth

A choropleth trace is a struct inside fig.data which has type equal to 'choropleth'. This section lists all of the valid keys that a choropleth struct can contain.

The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`.

  • type ('choropleth')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'location', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'location', 'z', 'location+z', 'location+z+text', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • locations (array)
    Sets the coordinates via location IDs or names. See `locationmode` for more info.
  • locationmode (enumerated: 'ISO-3' | 'USA-states' | 'country names' )
    default: 'ISO-3'
    Determines the set of locations used to match entries in `locations` to regions on the map.
  • z (array)
    Sets the color values.
  • text (array)
    Sets the text elements associated with each location.
  • marker
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorsrc
      • widthsrc
  • zauto (boolean)
    default: true
    Determines the whether or not the color domain is computed with respect to the input data.
  • zmin (number)
    Sets the lower bound of color domain.
  • zmax (number)
    Sets the upper bound of color domain.
  • colorscale (colorscale)
    Sets the colorscale.
  • autocolorscale (boolean)
    default: true
    Determines whether or not the colorscale is picked using the sign of the input z values.
  • reversescale (boolean)
    Reverses the colorscale.
  • showscale (boolean)
    default: true
    Determines whether or not a colorbar is displayed for this trace.
  • colorbar
    • thicknessmode (enumerated: 'fraction' | 'pixels' )
      default: 'pixels'
      Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
    • thickness (number greater than or equal to 0)
      default: 30
      Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
    • lenmode (enumerated: 'fraction' | 'pixels' )
      default: 'fraction'
      Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
    • len (number greater than or equal to 0)
      default: 1
      Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
    • x (number between or equal to -2 and 3)
      default: 1.02
      Sets the x position of the color bar (in plot fraction).
    • xanchor (enumerated: 'left' | 'center' | 'right' )
      default: 'left'
      Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
    • xpad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the x direction.
    • y (number between or equal to -2 and 3)
      default: 0.5
      Sets the y position of the color bar (in plot fraction).
    • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
      default: 'middle'
      Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
    • ypad (number greater than or equal to 0)
      default: 10
      Sets the amount of padding (in px) along the y direction.
    • outlinecolor (color)
      default: '#444'
      Sets the axis line color.
    • outlinewidth (number greater than or equal to 0)
      default: 1
      Sets the width (in px) of the axis line.
    • bordercolor (color)
      default: '#444'
      Sets the axis line color.
    • borderwidth (number greater than or equal to 0)
      default: 0
      Sets the width (in px) or the border enclosing this color bar.
    • bgcolor (color)
      default: 'rgba(0,0,0,0)'
      Sets the color of padded area.
    • tickmode (enumerated: 'auto' | 'linear' | 'array' )
      Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
    • nticks (integer greater than or equal to 0)
      default: 0
      Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
    • tick0 (number)
      default: 0
      Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
    • dtick (number or categorical coordinate string)
      default: 1
      Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
    • tickvals (array)
      Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticktext (array)
      Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
    • ticks (enumerated: 'outside' | 'inside' | '' )
      default: ''
      Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
    • ticklen (number greater than or equal to 0)
      default: 5
      Sets the tick length (in px).
    • tickwidth (number greater than or equal to 0)
      default: 1
      Sets the tick width (in px).
    • tickcolor (color)
      default: '#444'
      Sets the tick color.
    • showticklabels (boolean)
      default: true
      Determines whether or not the tick labels are drawn.
    • tickfont
      Sets the tick font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • tickangle (angle)
      default: auto
      Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
    • tickformat (string)
      default: ''
      Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
    • tickprefix (string)
      default: ''
      Sets a tick label prefix.
    • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
    • ticksuffix (string)
      default: ''
      Sets a tick label suffix.
    • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      Same as `showtickprefix` but for tick suffixes.
    • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
      default: 'B'
      Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
    • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
      default: 'all'
      If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
    • title (string)
      default: 'Click to enter colorscale title'
      Sets the title of the color bar.
    • titlefont
      Sets this color bar's title font.
      • family (string)
        HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
      • size (number greater than or equal to 1)
      • color (color)
    • titleside (enumerated: 'right' | 'top' | 'bottom' )
      default: 'top'
      Determines the location of the colorbar title with respect to the color bar.
    • tickvalssrc
    • ticktextsrc
  • geo (geoid)
    default: geo
    Sets a reference between this trace's geospatial coordinates and a geographic map. If 'geo' (the default value), the geospatial coordinates refer to `layout.geo`. If 'geo2', the geospatial coordinates refer to `layout.geo2`, and so on.
  • locationssrc
  • zsrc
  • textsrc

scattergl

A scattergl trace is a struct inside fig.data which has type equal to 'scattergl'. This section lists all of the valid keys that a scattergl struct can contain.

The data visualized as scatter point or lines is set in `x` and `y` using the WebGl plotting engine. Bubble charts are achieved by setting `marker.size` and/or `marker.color` to a numerical arrays.

  • type ('scattergl')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • x (array)
    Sets the x coordinates.
  • x0 (number or categorical coordinate string)
    default: 0
    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.
  • dx (number)
    default: 1
    Sets the x coordinate step. See `x0` for more info.
  • y (array)
    Sets the y coordinates.
  • y0 (number or categorical coordinate string)
    default: 0
    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.
  • dy (number)
    default: 1
    Sets the y coordinate step. See `y0` for more info.
  • text (string)
    default: ''
    Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.
  • mode (flaglist string)
    Any combination of 'lines', 'markers' joined with a '+' OR 'none'.
    examples: 'lines', 'markers', 'lines+markers', 'none'
    Determines the drawing mode for this scatter trace.
  • line
    • color (color)
      Sets the line color.
    • width (number greater than or equal to 0)
      default: 2
      Sets the line width (in px).
    • dash (enumerated: 'solid' | 'dot' | 'dash' | 'longdash' | 'dashdot' | 'longdashdot' )
      default: 'solid'
      Sets the style of the lines.
  • marker
    • color (color)
      Sets the marker color.
    • symbol (enumerated: 'circle' | 'circle-open' | 'square' | 'square-open' | 'diamond' | 'diamond-open' | 'cross' | 'x' )
      default: 'circle'
      Sets the marker symbol type.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • sizeref (number)
      default: 1
      Has only an effect if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    • sizemin (number greater than or equal to 0)
      default: 0
      Has only an effect if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    • sizemode (enumerated: 'diameter' | 'area' )
      default: 'diameter'
      Has only an effect if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorscale (colorscale)
      Has only an effect if `marker.color` is set to a numerical array. Sets the colorscale.
    • cauto (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines the whether or not the color domain is computed automatically.
    • cmax (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the upper bound of the color domain.
    • cmin (number)
      Has only an effect if `marker.color` is set to a numerical array. Sets the lower bound of the color domain.
    • autocolorscale (boolean)
      default: true
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not the colorscale is picked using values inside `marker.color`.
    • reversescale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Reverses the colorscale.
    • showscale (boolean)
      Has only an effect if `marker.color` is set to a numerical array. Determines whether or not a colorbar is displayed.
    • line
      • color (color)
        Sets the color of the lines bounding the marker points.
      • width (number greater than or equal to 0)
        Sets the width (in px) of the lines bounding the marker points.
      • colorscale (colorscale)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the colorscale.
      • cauto (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines the whether or not the color domain is computed with respect to the input data.
      • cmax (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the upper bound of the color domain.
      • cmin (number)
        Has only an effect if `marker.line.color` is set to a numerical array. Sets the lower bound of the color domain.
      • autocolorscale (boolean)
        default: true
        Has only an effect if `marker.line.color` is set to a numerical array. Determines whether or not the colorscale is picked using the sign of values inside `marker.line.color`.
      • reversescale (boolean)
        Has only an effect if `marker.line.color` is set to a numerical array. Reverses the colorscale.
      • colorsrc
      • widthsrc
    • colorbar
      • thicknessmode (enumerated: 'fraction' | 'pixels' )
        default: 'pixels'
        Determines whether this color bar's thickness (i.e. the measure in the constant color direction) is set in units of plot 'fraction' or in 'pixels'. Use `thickness` to set the value.
      • thickness (number greater than or equal to 0)
        default: 30
        Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
      • lenmode (enumerated: 'fraction' | 'pixels' )
        default: 'fraction'
        Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot 'fraction' or in 'pixels. Use `len` to set the value.
      • len (number greater than or equal to 0)
        default: 1
        Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.
      • x (number between or equal to -2 and 3)
        default: 1.02
        Sets the x position of the color bar (in plot fraction).
      • xanchor (enumerated: 'left' | 'center' | 'right' )
        default: 'left'
        Sets this color bar's horizontal position anchor. This anchor binds the `x` position to the 'left', 'center' or 'right' of the color bar.
      • xpad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the x direction.
      • y (number between or equal to -2 and 3)
        default: 0.5
        Sets the y position of the color bar (in plot fraction).
      • yanchor (enumerated: 'top' | 'middle' | 'bottom' )
        default: 'middle'
        Sets this color bar's vertical position anchor This anchor binds the `y` position to the 'top', 'middle' or 'bottom' of the color bar.
      • ypad (number greater than or equal to 0)
        default: 10
        Sets the amount of padding (in px) along the y direction.
      • outlinecolor (color)
        default: '#444'
        Sets the axis line color.
      • outlinewidth (number greater than or equal to 0)
        default: 1
        Sets the width (in px) of the axis line.
      • bordercolor (color)
        default: '#444'
        Sets the axis line color.
      • borderwidth (number greater than or equal to 0)
        default: 0
        Sets the width (in px) or the border enclosing this color bar.
      • bgcolor (color)
        default: 'rgba(0,0,0,0)'
        Sets the color of padded area.
      • tickmode (enumerated: 'auto' | 'linear' | 'array' )
        Sets the tick mode for this axis. If 'auto', the number of ticks is set via `nticks`. If 'linear', the placement of the ticks is determined by a starting position `tick0` and a tick step `dtick` ('linear' is the default value if `tick0` and `dtick` are provided). If 'array', the placement of the ticks is set via `tickvals` and the tick text is `ticktext`. ('array' is the default value if `tickvals` is provided).
      • nticks (integer greater than or equal to 0)
        default: 0
        Sets the number of ticks. Has an effect only if `tickmode` is set to 'auto'.
      • tick0 (number)
        default: 0
        Sets the placement of the first tick on this axis. Use with `dtick`. If the axis `type` is 'log', then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the `tick0` to 2). If the axis `type` is 'date', then you must convert the date to unix time in milliseconds (the number of milliseconds since January 1st, 1970). For example, to set the starting tick to November 4th, 2013, set the range to 1380844800000.0.
      • dtick (number or categorical coordinate string)
        default: 1
        Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is 'log', then ticks are set every 10^(n'dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is 'date', then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.
      • tickvals (array)
        Sets the values at which ticks on this axis appear. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticktext (array)
        Sets the text displayed at the ticks position via `tickvals`. Only has an effect if `tickmode` is set to 'array'. Used with `ticktext`.
      • ticks (enumerated: 'outside' | 'inside' | '' )
        default: ''
        Determines whether ticks are drawn or not. If '', this axis' ticks are not drawn. If 'outside' ('inside'), this axis' are drawn outside (inside) the axis lines.
      • ticklen (number greater than or equal to 0)
        default: 5
        Sets the tick length (in px).
      • tickwidth (number greater than or equal to 0)
        default: 1
        Sets the tick width (in px).
      • tickcolor (color)
        default: '#444'
        Sets the tick color.
      • showticklabels (boolean)
        default: true
        Determines whether or not the tick labels are drawn.
      • tickfont
        Sets the tick font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • tickangle (angle)
        default: auto
        Sets the angle of the tick labels with respect to the horizontal. For example, a `tickangle` of -90 draws the tick labels vertically.
      • tickformat (string)
        default: ''
        Sets the tick label formatting rule using the python/d3 number formatting language. See https://github.com/mbostock/d3/wiki/Formatting#numbers or https://docs.python.org/release/3.1.3/library/string.html#formatspec for more info.
      • tickprefix (string)
        default: ''
        Sets a tick label prefix.
      • showtickprefix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all tick labels are displayed with a prefix. If 'first', only the first tick is displayed with a prefix. If 'last', only the last tick is displayed with a suffix. If 'none', tick prefixes are hidden.
      • ticksuffix (string)
        default: ''
        Sets a tick label suffix.
      • showticksuffix (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        Same as `showtickprefix` but for tick suffixes.
      • exponentformat (enumerated: 'none' | 'e' | 'E' | 'power' | 'SI' | 'B' )
        default: 'B'
        Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If 'none', it appears as 1,000,000,000. If 'e', 1e+9. If 'E', 1E+9. If 'power', 1x10^9 (with 9 in a super script). If 'SI', 1G. If 'B', 1B.
      • showexponent (enumerated: 'all' | 'first' | 'last' | 'none' )
        default: 'all'
        If 'all', all exponents are shown besides their significands. If 'first', only the exponent of the first tick is shown. If 'last', only the exponent of the last tick is shown. If 'none', no exponents appear.
      • title (string)
        default: 'Click to enter colorscale title'
        Sets the title of the color bar.
      • titlefont
        Sets this color bar's title font.
        • family (string)
          HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include 'Arial', 'Balto', 'Courier New', 'Droid Sans',, 'Droid Serif', 'Droid Sans Mono', 'Gravitas One', 'Old Standard TT', 'Open Sans', 'Overpass', 'PT Sans Narrow', 'Raleway', 'Times New Roman'.
        • size (number greater than or equal to 1)
        • color (color)
      • titleside (enumerated: 'right' | 'top' | 'bottom' )
        default: 'top'
        Determines the location of the colorbar title with respect to the color bar.
      • tickvalssrc
      • ticktextsrc
    • colorsrc
    • symbolsrc
    • sizesrc
    • opacitysrc
  • fill (enumerated: 'none' | 'tozeroy' | 'tozerox' )
    default: 'none'
    Sets the area to fill with a solid color. Use with `fillcolor`.
  • fillcolor (color)
    Sets the fill color.
  • error_x
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • error_y
    • visible (boolean)
      Determines whether or not this set of error bars is visible.
    • type (enumerated: 'percent' | 'constant' | 'sqrt' | 'data' )
      Determines the rule used to generate the error bars. If 'constant`, the bar lengths are of a constant value. Set this constant in `value`. If 'percent', the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If 'sqrt', the bar lengths correspond to the sqaure of the underlying data. If 'array', the bar lengths are set with data set `array`.
    • symmetric (boolean)
      Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
    • array (array)
      Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
    • arrayminus (array)
      Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
    • value (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars.
    • valueminus (number greater than or equal to 0)
      default: 10
      Sets the value of either the percentage (if `type` is set to 'percent') or the constant (if `type` is set to 'constant') corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
    • traceref (integer greater than or equal to 0)
      default: 0
    • tracerefminus (integer greater than or equal to 0)
      default: 0
    • copy_ystyle (boolean)
    • copy_zstyle (boolean)
    • color (color)
      Sets the stoke color of the error bars.
    • thickness (number greater than or equal to 0)
      default: 2
      Sets the thickness (in px) of the error bars.
    • width (number greater than or equal to 0)
      Sets the width (in px) of the cross-bar at both ends of the error bars.
    • arraysrc
    • arrayminussrc
  • xaxis (axisid)
    default: x
    Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If 'x' (the default value), the x coordinates refer to `layout.xaxis`. If 'x2', the x coordinates refer to `layout.xaxis2`, and so on.
  • yaxis (axisid)
    default: y
    Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If 'y' (the default value), the y coordinates refer to `layout.yaxis`. If 'y2', the y coordinates refer to `layout.xaxis2`, and so on.
  • xsrc
  • ysrc
  • textsrc

area

A area trace is a struct inside fig.data which has type equal to 'area'. This section lists all of the valid keys that a area struct can contain.



  • type ('area')
  • visible (enumerated: true | false | 'legendonly' )
    default: true
    Determines whether or not this trace is visible. If 'legendonly', the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
  • showlegend (boolean)
    default: true
    Determines whether or not an item corresponding to this trace is shown in the legend.
  • legendgroup (string)
    default: ''
    Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  • opacity (number between or equal to 0 and 1)
    default: 1
    Sets the opacity of the trace.
  • name (string)
    Sets the trace name. The trace name appear as the legend item and on hover.
  • hoverinfo (flaglist string)
    Any combination of 'x', 'y', 'z', 'text', 'name' joined with a '+' OR 'all' or 'none'.
    examples: 'x', 'y', 'x+y', 'x+y+z', 'all'
    default: 'all'
    Determines which trace information appear on hover.
  • stream
    • token (string)
      The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.
    • maxpoints (number greater than or equal to 0)
      Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to '50', only the newest 50 points will be displayed on the plot.
  • r (array)
    For polar chart only.Sets the radial coordinates.
  • t (array)
    For polar chart only.Sets the angular coordinates.
  • marker
    • color (color)
      Sets the marker color.
    • size (number greater than or equal to 0)
      default: 6
      Sets the marker size (in px).
    • symbol (enumerated: '0' | 'circle' | '100' | 'circle-open' | '200' | 'circle-dot' | '300' | 'circle-open-dot' | '1' | 'square' | '101' | 'square-open' | '201' | 'square-dot' | '301' | 'square-open-dot' | '2' | 'diamond' | '102' | 'diamond-open' | '202' | 'diamond-dot' | '302' | 'diamond-open-dot' | '3' | 'cross' | '103' | 'cross-open' | '203' | 'cross-dot' | '303' | 'cross-open-dot' | '4' | 'x' | '104' | 'x-open' | '204' | 'x-dot' | '304' | 'x-open-dot' | '5' | 'triangle-up' | '105' | 'triangle-up-open' | '205' | 'triangle-up-dot' | '305' | 'triangle-up-open-dot' | '6' | 'triangle-down' | '106' | 'triangle-down-open' | '206' | 'triangle-down-dot' | '306' | 'triangle-down-open-dot' | '7' | 'triangle-left' | '107' | 'triangle-left-open' | '207' | 'triangle-left-dot' | '307' | 'triangle-left-open-dot' | '8' | 'triangle-right' | '108' | 'triangle-right-open' | '208' | 'triangle-right-dot' | '308' | 'triangle-right-open-dot' | '9' | 'triangle-ne' | '109' | 'triangle-ne-open' | '209' | 'triangle-ne-dot' | '309' | 'triangle-ne-open-dot' | '10' | 'triangle-se' | '110' | 'triangle-se-open' | '210' | 'triangle-se-dot' | '310' | 'triangle-se-open-dot' | '11' | 'triangle-sw' | '111' | 'triangle-sw-open' | '211' | 'triangle-sw-dot' | '311' | 'triangle-sw-open-dot' | '12' | 'triangle-nw' | '112' | 'triangle-nw-open' | '212' | 'triangle-nw-dot' | '312' | 'triangle-nw-open-dot' | '13' | 'pentagon' | '113' | 'pentagon-open' | '213' | 'pentagon-dot' | '313' | 'pentagon-open-dot' | '14' | 'hexagon' | '114' | 'hexagon-open' | '214' | 'hexagon-dot' | '314' | 'hexagon-open-dot' | '15' | 'hexagon2' | '115' | 'hexagon2-open' | '215' | 'hexagon2-dot' | '315' | 'hexagon2-open-dot' | '16' | 'octagon' | '116' | 'octagon-open' | '216' | 'octagon-dot' | '316' | 'octagon-open-dot' | '17' | 'star' | '117' | 'star-open' | '217' | 'star-dot' | '317' | 'star-open-dot' | '18' | 'hexagram' | '118' | 'hexagram-open' | '218' | 'hexagram-dot' | '318' | 'hexagram-open-dot' | '19' | 'star-triangle-up' | '119' | 'star-triangle-up-open' | '219' | 'star-triangle-up-dot' | '319' | 'star-triangle-up-open-dot' | '20' | 'star-triangle-down' | '120' | 'star-triangle-down-open' | '220' | 'star-triangle-down-dot' | '320' | 'star-triangle-down-open-dot' | '21' | 'star-square' | '121' | 'star-square-open' | '221' | 'star-square-dot' | '321' | 'star-square-open-dot' | '22' | 'star-diamond' | '122' | 'star-diamond-open' | '222' | 'star-diamond-dot' | '322' | 'star-diamond-open-dot' | '23' | 'diamond-tall' | '123' | 'diamond-tall-open' | '223' | 'diamond-tall-dot' | '323' | 'diamond-tall-open-dot' | '24' | 'diamond-wide' | '124' | 'diamond-wide-open' | '224' | 'diamond-wide-dot' | '324' | 'diamond-wide-open-dot' | '25' | 'hourglass' | '125' | 'hourglass-open' | '26' | 'bowtie' | '126' | 'bowtie-open' | '27' | 'circle-cross' | '127' | 'circle-cross-open' | '28' | 'circle-x' | '128' | 'circle-x-open' | '29' | 'square-cross' | '129' | 'square-cross-open' | '30' | 'square-x' | '130' | 'square-x-open' | '31' | 'diamond-cross' | '131' | 'diamond-cross-open' | '32' | 'diamond-x' | '132' | 'diamond-x-open' | '33' | 'cross-thin' | '133' | 'cross-thin-open' | '34' | 'x-thin' | '134' | 'x-thin-open' | '35' | 'asterisk' | '135' | 'asterisk-open' | '36' | 'hash' | '136' | 'hash-open' | '236' | 'hash-dot' | '336' | 'hash-open-dot' | '37' | 'y-up' | '137' | 'y-up-open' | '38' | 'y-down' | '138' | 'y-down-open' | '39' | 'y-left' | '139' | 'y-left-open' | '40' | 'y-right' | '140' | 'y-right-open' | '41' | 'line-ew' | '141' | 'line-ew-open' | '42' | 'line-ns' | '142' | 'line-ns-open' | '43' | 'line-ne' | '143' | 'line-ne-open' | '44' | 'line-nw' | '144' | 'line-nw-open' )
      default: 'circle'
      Sets the marker symbol type. Adding 100 is equivalent to appending '-open' to a symbol name. Adding 200 is equivalent to appending '-dot' to a symbol name. Adding 300 is equivalent to appending '-open-dot' or 'dot-open' to a symbol name.
    • opacity (number between or equal to 0 and 1)
      Sets the marker opacity.
    • colorsrc
    • sizesrc
    • symbolsrc
    • opacitysrc
  • rsrc
  • tsrc

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout

layout